This resource address returns information on the specified request. The request
can be identified either by id or URI.
URL Parameters
format
The format of the returned data. Can be either
html, json, or xml (default). This value overrides
the Accept header if both are present.
group-id
Specifies to limit the summary information to
requests in the specified group. The group can be identified either by id or name.
host-id
Specifies to limit the information to the request
in the specified host. The host can be identified either by id or name.
server-id
Specifies to limit the information to the
request in the specified server. The server can be identified either by id or name.
Request Headers
Accept
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header.
Response Headers
Content-type
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
Response
Upon success, MarkLogic Server returns status code 200 (OK). The response body
contains the requested data.
Required Privileges
This operation requires the manage-user role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The structure of the output returned from
this REST API is as follows:
id
An id for a request
meta
Properties of the view rather than the resource.
This is a complex structure with the following children:
uri
The path to the view.
current-time
The timestamp for when the view was generated.
elapsed-time
The time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-min
The timestamp for filtering out more recent
requests or transactions.
view-error
An error limiting the data in the view.
This is a complex structure with the following children:
error-type
The kind of error.
error-name
The name of the error.
error-code
The error identifier.
error-message
The error text.
relations
Relationships to resources.
This is a complex structure with the following children:
relation-group
Related resources with the same type.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
relation-count
The number of related resources.
relation
A specific related resource.
This is a complex structure with the following children:
qualifiers
A list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifier
Another resource that qualifies the resource.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
properties
Characteristics of the request.
This is a complex structure with the following children:
seconds-elapsed
How long the request has been
running.
canceled
Has this request been canceled.
root
The root document directory pathname.
request-kind
The kind of request (for example, invoke, eval).
request-text
The request text.
request-rewritten-text
The rewritten request text.
update
Specifies if this request an update (true for update requests).
start-time
The time the operation started.
time-limit
The request's time limit, in seconds.
max-time-limit
The upper bound for a request's time limit, in seconds.
lock-count
The request's current limit on combined count for the
number of times a read or a write lock was acquired.
read-size
The request's current limit on combined size read from
disk (listSize+compressedTreeSize), in bytes.
user
The unique ID of the user executing the request.
client-address
The network address of a client
trigger-depth
The maximum depth of trigger invocation.
expanded-tree-cache-hits
The number of hits on the expanded cache.
expanded-tree-cache-misses
The number of misses on the expanded cache.
request-state
The state of a request
profiling-allowed
Is profiling allowed for this request.
profiling-enabled
Is profiling currently enabled for this request.
debugging-allowed
Is debugging allowed for this request.
debugging-status
The debugging status of the request.
retry-count
The number of retries on the request.
expr-id
The expression id.
where-stopped
Where the request is stopped.
related-views
A list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-view
A broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-type
The kind of view.
view-name
The name of the view.
view-uri
The path for the view.
Example
http://localhost:8002/manage/v2/requests/12741641870611184141
==> Returns information on the request with the id, 12741641870611184141.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.